home *** CD-ROM | disk | FTP | other *** search
/ Amiga Collections: Taifun / Taifun 029 (1987-08-15)(Ossowski, Stefan)(DE)(PD).zip / Taifun 029 (1987-08-15)(Ossowski, Stefan)(DE)(PD).adf / ue18 / Uedit-ReadMe < prev    next >
Text File  |  1978-08-10  |  18KB  |  633 lines
  1. *****************************************************************************
  2. DO THIS NOW in CLI:        Copy  Data!   S:
  3.                            Copy  Config! S:
  4.                            Copy  Help!   S:
  5.                            Run UE
  6. *****************************************************************************
  7.  
  8.                                 Uedit V1.8
  9.                     Copyright (C) 1986-87, Rick Stiles
  10.                         2420 Summit Springs Drive
  11.                             Atlanta, GA 30338
  12.  
  13. Dear folks,
  14.  
  15. Uedit is a ShareWare text editor.  Copy and distribute Uedit.arc freely to
  16. your friends and bulletin boards.
  17.  
  18.             ***  DO NOT ALTER THE ORIGINAL UEDIT.ARC FILE! ***
  19.  
  20.             **************************************************
  21.                        *** Press Alt-downArrow ***
  22.             **************************************************
  23.  
  24.  
  25. Distribute ONLY the Original Uedit.arc with its contents unchanged.
  26.  
  27.  
  28.  
  29. Run VERIFY to see if any files have been changed or corrupted.
  30.  
  31.  
  32. If anything isn't right, contact me or your bulletin board and make sure that
  33. a fresh Uedit.arc replaces the bad one.
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.                               !!! NOTICE !!!
  44.  
  45.  
  46. Uedit is ShareWare.  It is not a free public domain program.
  47.  
  48. Feel free to give copies of Uedit.arc to friends and bulletin boards.
  49.  
  50. It must not be used for commercial purposes.
  51.  
  52.  
  53. Try Uedit for a while.  If you find it useful, send the $25 user fee and get
  54. the Manual.
  55.  
  56. The Manual has over 100 pages and is loaded with documentation, examples, and
  57. editing tricks.
  58.  
  59.  
  60. Send $25 cash, check or money order to:
  61.  
  62.                        Rick Stiles
  63.                        2420 Summit Springs Drive
  64.                        Atlanta GA, 30338
  65.  
  66.  
  67.             *************************************************
  68.  
  69. If you are a commercial software or hardware company and wish to include
  70. Uedit with your product, contact me about it.
  71.  
  72.             *************************************************
  73.  
  74.  
  75.  
  76.                                About Uedit
  77.  
  78.  
  79. Uedit is Extremely flexible and powerful.
  80.  
  81. You can use it immediately.  The menus and Help are all you need.
  82.  
  83.  
  84. The goals in writing Uedit were openness, flexibility, power, friendliness -
  85. above all to give Freedom of Choice to the user.
  86.  
  87.  
  88. Being able to edit 20 files is only the beginning of the depth Uedit has got.
  89.  
  90. Learn Mode adds a new dimension, providing instant automation for people who
  91. hate reading instructions and only want to know enough to get the job done.
  92.  
  93.  
  94. The command language adds another dimension, letting you rewrite Every
  95. command, even the gadget and mouse button commands - on the fly.
  96.  
  97. Then there is the overall configurability and customizability, being able to
  98. swap and kill keys, select colors, customize the menus, etc.
  99.  
  100. Then there is the ability to switch configurations, changing the entire
  101. personality of Uedit, without interrupting editing.  
  102.  
  103. Then there is the fact that it sleeps so that other tasks run efficiently and
  104. can start other tasks and load in their results so that you can use them.
  105.  
  106.  
  107. The biggest flaw in Uedit is text displaying speed.
  108.  
  109. It uses the Amiga's text functions.  The Amiga's text functions are Slow.
  110.  
  111.  
  112. A super-fast upgrade is planned.  Also a Serial Communications enhancement.
  113.  
  114.  
  115. Until the super-fast upgrade is available, you should consider using
  116. Microsmith's Fast Fonts (tm).  It will double Uedit's displaying speed.
  117.  
  118.  
  119.  
  120.                                  The Deal
  121.  
  122.  
  123. As I would like to do a Super-Fast upgrade and a Serial-Comm enhancement,
  124. both of which would be extremely useful, and as it depends on whether or not
  125. you make it worth while, here are the choices:
  126.  
  127.  
  128. When you send $25 for the Manual:
  129.  
  130. 1)  You can get the Super-Fast upgrade when it's ready for $15 extra.
  131.  
  132. 2)  You can get the Serial-Comm upgrade when it's ready for $15 extra.
  133.  
  134. These upgrades should be ready in 6-8 weeks.  (Sooner if enough people ask for
  135. them.)
  136.  
  137. That way you needn't feel tempted to wait before sending in the $25 user fee.
  138.  
  139. And if not enough people order the upgrades to make doing them worth while,
  140. I will send your $15 back.
  141.  
  142. Fair enough?
  143.  
  144.  
  145.  
  146.                             Config! and Data!
  147.  
  148.  
  149. Config! is a configuration file which is the Source of every command Uedit
  150. currently uses.
  151.  
  152. Data! is a compiled copy of Config! which Uedit loads at startup.
  153.  
  154. These need to be in your S: volume, along with Help!, the help file.
  155.  
  156.  
  157. You can keep as many config and data files as you want.
  158.  
  159. Configuration files are written in command language which reads like English.
  160.  
  161.  
  162. The "Save config" and "Load config" commands in the menu let you switch
  163. configurations and save changes to Uedit that you have made while editing.
  164.  
  165. Thus you can customize Uedit while using it.
  166.  
  167.  
  168. The menu selections say "config", but in fact it is a Data file you are
  169. loading or saving.
  170.  
  171. You can load and save data files from/to any directory and under any name.
  172.  
  173.  
  174. Config! and Data! are the default configuration and data files and must be in
  175. the S: volume.
  176.  
  177.  
  178. The command language was not created to give you something you'd have to read
  179. about and learn to use.
  180.  
  181. Ignore the command language.  It only exists in order to provide the openness
  182. that Uedit's philosophy demands.
  183.  
  184.  
  185. If you can't use Uedit productively right off using only the menus and Help
  186. file, then Uedit has failed miserably.
  187.  
  188. Uedit V1.0 wasn't friendly enough.
  189.  
  190. But after much improving in response to user feedback, people started saying
  191. that they chose Uedit because of its friendliness.
  192.  
  193.  
  194.  
  195.                               Editing Tricks
  196.  
  197.  
  198. If you are like me and hate reading instructions, and expect programs to be
  199. Easy Without Reading, then Learn Mode is for you.
  200.  
  201. No reading necessary.  It uses only the normal editing stuff.
  202.  
  203. It offers immense power and capacity to automate tedious chores.
  204.  
  205.  
  206. For instance, it has been used to convert as many as 40 program modules from
  207. BASIC or Pascal to C.  It could as easily have been 400 modules.  Setting up
  208. took about a minute, then Uedit did them all, one by one.
  209.  
  210.  
  211. The Manual has lots of Examples and Editing Tricks which show how to take
  212. advantage of Uedit's flexibility and power.
  213.  
  214.  
  215. The Manual describes how to use Learn Mode to click-add numbers or click-
  216. bracket words, do mail-merges, and so on.
  217.  
  218.  
  219. If you need to search and replace misspelled names in 300 documents, you can
  220. teach Learn Mode how to do one and then let it do them all.
  221.  
  222.  
  223. To set up for such chores takes maybe thirty seconds.
  224.  
  225.  
  226. You could easily write simple commands which run tasks on the Amiga at the
  227. press of a key.  
  228.  
  229. But you could more quickly teach Learn Mode to do it.
  230.  
  231.  
  232. Anything you'd write a command for, Learn Mode can probably be set up to do
  233. in seconds.
  234.  
  235.  
  236. A useful trick is to swap "Run learn" (ctl-r) with the mouse's buttonUp
  237. operation.
  238.  
  239. Then when you click the button, buttonDown will deposit the cursor like it
  240. normally does, and buttonUp will execute a learned sequence!
  241.  
  242.  
  243. The learned sequence can be anything.
  244.  
  245. It can, for instance, click-bracket words with printer control codes.  The
  246. Manual's Editing Tricks present such examples.
  247.  
  248.  
  249. Or you can swap the mouse's buttonUp operation with another key, such as
  250. the add-numbers key (ctl-=).
  251.  
  252. Then you can click-add numbers that are scattered in various documents.
  253. Pressing ctl-\ will put the running total into the text at the cursor.
  254.  
  255.  
  256. Note that if you want to swap the mouse's buttonUp operation with a key,
  257. gadget, or menu selection, you need to keep buttonDown from getting into the
  258. swap.
  259.  
  260. You should press the mouse button and hold it, select "Swap keys", then
  261. release the button and press the key you're swapping it with.
  262.  
  263.  
  264. If you select "Swap keys" and click the mouse button, you'll be swapping the
  265. buttonDown and buttonUp operations.
  266.  
  267.  
  268. Learned sequences can be stored on disk as numbered files.  They are stored
  269. in the S: volume.
  270.  
  271. You can easily write key-commands which load and run learned sequences stored
  272. on disk.  A command to load & run learn sequence #3 would look like this:
  273.  
  274.            <shftAlt-3: if (loadLearn(3)) runLearn >
  275.  
  276.  
  277. Type it anywhere in any buffer.  Select "Compile" (F6) to compile it.  Select
  278. "Save config" to make it available next time as part of Uedit's configuration.
  279.  
  280. Learn sequence #3 might go to top of document and type in a header, or go to
  281. bottom of document and insert your name and address.
  282.  
  283.  
  284.  
  285.                                Customizing
  286.  
  287.  
  288. You can customize Uedit virtually to the point of redesigning it.
  289.  
  290. You can customize it while using it, or by editing and compiling a config
  291. file.
  292.  
  293.  
  294. If you run Uedit by typing "Run UE -dDataFile .." or "Run UE -cConfigFile .."
  295. in CLI, it will load DataFile or compile ConfigFile.
  296.  
  297. You can switch configurations while editing by selecting "Load config".
  298.  
  299.  
  300. The configurability of Uedit is extreme.
  301.  
  302.  
  303. One user made Uedit a disk housekeeping utility by cloning commands off of
  304. the click-loading command.  (Type a filename anywhere, then press Ctrl and
  305. click the filename.)
  306.  
  307. His commands click-delete and click-copy files.
  308.  
  309.  
  310. Tom Althoff, a user in NY, has written Uedit commands which behave like
  311. Borland's Turbo Pascal (tm) editor.
  312.  
  313. Click a gadget, and Uedit will save changes, tell DOS to compile modules,
  314. detect errors, reload the offending module, and put the cursor On The Error!
  315.  
  316. The compiler's error message is displayed in the message line!
  317.  
  318.  
  319. Tom's commands work with the Manx Aztec C (tm) compiler and assembler, but
  320. they're easy to modify for other compilers.
  321.  
  322. If you can't find his commands on your bulletin board, contact Tom Althoff,
  323. P O Box K-43, Greenwood Lake, NY 10925.  He will send you them to you, along
  324. with other tools he has written to use with Uedit.
  325.  
  326.  
  327.  
  328.                               Odds and Ends
  329.  
  330.  
  331. Here are some odds and ends to help get you started.
  332.  
  333.  
  334. To abort any operation, press Amiga-ESC.
  335.  
  336.  
  337. Primitive Mode is what Uedit is when it has no config.  The Title Bar and the
  338. message line tell you what to do in Primitive Mode.
  339.  
  340. Primitive Mode is used for text and number input.  If you press F7 to input a
  341. search string, you'll be in Primitive Mode.
  342.  
  343.  
  344. Primitive Mode is also used when compiling the config file at startup and an
  345. error is found.  Uedit puts you on the error spot so you can correct it.
  346.  
  347. At that point it has no commands, so you are stuck using the bare bones until
  348. the config has finished compiling.
  349.  
  350.  
  351. You can search for two things at once by putting a "$" dollar sign between
  352. two search strings.
  353.  
  354. The "?" question mark is used by search as a wildcard.
  355.  
  356.  
  357. You can change these by editing Config! or by selecting "Set wildcard" or
  358. "Set eitherOr".
  359.  
  360. "Search caps" lets you toggle on and off the case-sensitivity of searching.
  361.  
  362.  
  363. Using all key, mouse and gadget Shft/Alt/Ctl prefix-combinations, you can
  364. have more than 800 commands on-line at the same time.
  365.  
  366. Keys can load, compile, run, swap, and kill other keys, so there really is no
  367. limit.
  368.  
  369.  
  370. Everything - including the Close Box - can have up to 8 commands attached, by
  371. using all combinations of Shft, Alt & Ctl.
  372.  
  373.  
  374. There are 4 "invisible" gadgets in the message line.  You can mark or unmark
  375. them by selecting "Mark gadgets".
  376.  
  377. Using Shft, Alt and Ctl, there are 32 gadgets in all.
  378.  
  379. Gadgets are just like keys and mouse clicks.  They can be swapped, killed,
  380. reprogrammed, learned, used by menu selections, and so on.
  381.  
  382.  
  383. Menu selections are always attached to a key, gadget or mouse button command.
  384.  
  385. If no command exists - or if you kill it and select "Save config" - the menu
  386. selection won't appear next time, but a warning box will remind you.
  387.  
  388.  
  389. If you swap a menu selection, the key you swapped it with will be executed
  390. whenever you select that menu item.
  391.  
  392.  
  393. You can run other programs from inside Uedit and have the results loaded in
  394. ("DOS + result") or ignored ("AmigaDOS").
  395.  
  396.  
  397. Uedit sleeps when it can, so that other tasks will run faster.
  398.  
  399.  
  400. Clicking the Title Bar will switch to the tiny window.  It comes up inactive,
  401. so you can type into CLI immediately.
  402.  
  403. This also lets the Amiga reopen the big window in a better memory location.
  404.  
  405.  
  406. If Uedit runs out of memory and the "Memory..." message appears, that means
  407. it is compacting its stuff in memory, creating a larger area for the Amiga to
  408. use for graphics.
  409.  
  410. If "Memory..." appears, you ought to save and close some documents.
  411.  
  412. Also it's a good idea to click the Title Bar and reopen Uedit's window.
  413.  
  414.  
  415. Uedit sleeps between your inputs.
  416.  
  417. If you don't type anything for 4 seconds, it will do housekeeping.
  418.  
  419. If you select "Busies", you'll see which buffer is being worked on.
  420.  
  421. When the housekeeping is done, it sleeps.
  422.  
  423.  
  424. Uedit displays twice as many lines of text when Interlace is used.
  425.  
  426. It picks up font changes made with Preferences immediately.  It works with
  427. all known hardware add-ons.  It looks for the most recent Amiga libraries.
  428.  
  429.  
  430. Some people start Uedit in their Workbench Startup-Sequence and do everything
  431. from inside it.  They let Uedit run other tasks and continue editing or
  432. let Uedit sleep.
  433.  
  434.  
  435. To see the demo, press shift-alt-ctrl-d.  The file "demo" will need to be in
  436. your current directory.
  437.  
  438. The demo is useless, except as an example.  It compiles and runs commands,
  439. then reloads the original config after the demo has finished.
  440.  
  441.  
  442. All flag settings, such as "Favorite" and "Word wrap" toggle like a light
  443. switch.  If "Word wrap" is Yes, selecting "Word wrap" switches it to No.  And
  444. vice versa.
  445.  
  446.  
  447. To see the current Settings, press shift-HELP or select "Show flags".
  448.  
  449.  
  450. Some settings are global and others are local to the current document.
  451.  
  452. Changing a local setting like word-wrap changes the global setting for future
  453. files loaded in.
  454.  
  455. Selecting "Save config" saves the current settings.
  456.  
  457.  
  458. To print a region, hilite it and press ctl-p.
  459.  
  460.  
  461. Hilite can be created in 3 ways.  Invert can be created in 2 ways.  Press
  462. HELP to see how.
  463.  
  464.  
  465. If "Print Pref" is Yes, printing will go through Preferences, which can be to
  466. a serial or parallel printer.
  467.  
  468. If "Print Pref" is No, printing goes to the parallel port in raw form, so
  469. Preferences can't filter your text.
  470.  
  471.  
  472. By choosing Serial Printer in Preferences, you can select either a parallel
  473. or serial printer by toggling "Print Pref" in Uedit.
  474.  
  475.  
  476. To set Colors, press alt-HELP until you see a combination that you like.
  477.  
  478. Then select "Save config".
  479.  
  480.  
  481. When choosing colors, you should create a hilited region which overlaps an
  482. inverted region, so that you can watch their colors.
  483.  
  484.  
  485. Menus keep their old colors until they're rebuilt.  To force them to be
  486. rebuilt, click the Title Bar and then the tiny window.
  487.  
  488.  
  489. To save changes in defaults, or after compiling commands, or after swapping
  490. or killing keys, you must select "Save config".
  491.  
  492.  
  493. To recover the original config after fooling around with commands, colors,
  494. etc, select "Load config".
  495.  
  496.  
  497. To make something happen automatically at startup, write a command like this:
  498.  
  499.     <ShftAltCtl-z: LoadFile("Manual.Table") LoadFile("Uedit-ReadMe") >
  500.  
  501.  
  502. You must use ShftAltCtl-z, unless you change the startup command in the
  503. config file.
  504.  
  505. Select "Compile" (F6).
  506.  
  507. Uedit will find the "<" angle bracket and compile the command.  Select "Save
  508. config" to save it.
  509.  
  510.  
  511. Then each time you start up, Uedit will run the command.
  512.  
  513.  
  514. You can make it load a config other than S:Data! by compiling a command like
  515. this:
  516.  
  517.                   <shftAltCtl-z: loadConfig("NewData")>.
  518.  
  519. Select "Save config", and Uedit will load and use NewData next time.  Pressing
  520. shftAltCtl-z would load it anytime.
  521.  
  522.  
  523. When Uedit comes up, it loads S:Data! first thing.
  524.  
  525. You can make it load NewData by typing "Run UE -dNewData ..." in CLI.
  526.  
  527. This would be faster than the above command would, since Uedit wouldn't have
  528. to load S:Data! first.
  529.  
  530.  
  531. To kill the startup auto-command (and make Uedit-ReadMe stop auto-loading),
  532. select "Kill key", press shftAltCtl-z, and select "Save config".
  533.  
  534. If you kill the wrong key and haven't saved it yet, select "Load config" and
  535. try again.
  536.  
  537.  
  538. The arrow keys are used for vertical and horizontal scrolling.  The shift
  539. keys determine the level of "power" of the scroll.
  540.  
  541.  
  542. The number-keypad keys are arranged logically and are easy to remember.
  543.  
  544.  
  545. The "5" key always "finds" the cursor.
  546.  
  547.  
  548. The 4, 6, 8 & 2 keys move the cursor left, right, up and down.  Again, the
  549. shift keys determine the level of "power".
  550.  
  551.  
  552. The 7 & 9 keys delete left and right.  Again, shift keys determine the
  553. "power".  (Ctl-d deletes lines of text.)
  554.  
  555. The 0 key is the Undo delete key.
  556.  
  557.  
  558. The 1 & 3 keys set start/end of hilite or invert regions.  Ctrl 1 & 3 are for
  559. invert.  Normal, Shft & Alt are for hilite.
  560.  
  561.  
  562. The ".", "-" and Enter keys are for Copy, Cut and Paste of hilite or invert
  563. regions.  Again, Ctrl is for invert and the rest are for hilite.
  564.  
  565.  
  566. To deactivate the keypad commands to use the keypad for number entry, select
  567. "Use keys".
  568.  
  569.  
  570.                             A Config Contest?
  571.  
  572.  
  573. There is a need for a number of really useful configs for Uedit to be
  574. available.  They would enhance Uedit's popularity.  
  575.  
  576. For example, nobody has written a WordStar (tm) config that I know of.
  577.  
  578. Configs are needed for all popular word processors and editors.
  579.  
  580.  
  581. But configs can be created for all sorts of things, such as disk housekeeping, 
  582. programming, and so on.  
  583.  
  584.  
  585. I thought about sponsoring a contest and offering $100 for the best config.
  586. Entries needn't be an entire configuration.  An entry could be just a set of
  587. commands for a specific purpose.
  588.  
  589. The entrance fee would be $10.  Each contestant would receive a disk with
  590. the best entries after the contest.
  591.  
  592.  
  593. The configs would be included with the Manual or put into the public domain,
  594. and the authors would credited.
  595.  
  596. What do you think?  When you send in the user fee, let me know if you would
  597. participate in the config contest.
  598.  
  599.  
  600. Entries would be judged on usefulness, originality, friendliness, and clarity.
  601.  
  602.  
  603.  
  604.                              Acknowledgements
  605.  
  606.  
  607. I wish to thank the users who have given helpful feedback on Uedit since it
  608. came out.
  609.  
  610. Most of the improvements since V1.0 have been because of their input.
  611.  
  612. I especially want to thank Tom Althoff and John Youells for all of their
  613. help, encouragement, and willingness to spend money on long distance calls in
  614. order to get Uedit out as ShareWare so that more people will discover it.
  615.  
  616.  
  617.  
  618.                       *****************************
  619.  
  620.  
  621. Your feedback will be appreciated.
  622.  
  623. And if you write a config or useful commands, send them to me and they'll be
  624. included with future releases.  If you don't send them to me, put them in the
  625. public domain.
  626.  
  627.  
  628.            Rick Stiles
  629.            2420 Summit Springs Drive
  630.            Atlanta, GA 30338
  631.  
  632.  
  633.